home *** CD-ROM | disk | FTP | other *** search
/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / MacOS 8 Resources / Developer Tools / Mac OS 8 Interfaces & Libraries / Interfaces / PInterfaces / OCE.p < prev    next >
Text File  |  1996-05-01  |  49KB  |  1,327 lines
  1. {
  2.      File:        OCE.p
  3.  
  4.      Contains:    Apple Open Collaboration Environment (AOCE) Interfaces.
  5.  
  6.      Version:    Technology:    AOCE Toolbox 1.02
  7.                  Release:    Universal Interfaces 3.0d3 on Copland DR1
  8.  
  9.      Copyright:    © 1984-1996 by Apple Computer, Inc.  All rights reserved.
  10.  
  11.      Bugs?:        If you find a problem with this file, send the file and version
  12.                  information (from above) and the problem description to:
  13.  
  14.                      Internet:    apple.bugs@applelink.apple.com
  15.                      AppleLink:    APPLE.BUGS
  16.  
  17. }
  18. {$IFC UNDEFINED UsingIncludes}
  19. {$SETC UsingIncludes := 0}
  20. {$ENDC}
  21.  
  22. {$IFC NOT UsingIncludes}
  23.  UNIT OCE;
  24.  INTERFACE
  25. {$ENDC}
  26.  
  27. {$IFC UNDEFINED __OCE__}
  28. {$SETC __OCE__ := 1}
  29.  
  30. {$I+}
  31. {$SETC OCEIncludes := UsingIncludes}
  32. {$SETC UsingIncludes := 1}
  33.  
  34. {$IFC UNDEFINED __TYPES__}
  35. {$I Types.p}
  36. {$ENDC}
  37. {$IFC UNDEFINED __ALIASES__}
  38. {$I Aliases.p}
  39. {$ENDC}
  40. {$IFC UNDEFINED __APPLEEVENTS__}
  41. {$I AppleEvents.p}
  42. {$ENDC}
  43.  
  44. {$PUSH}
  45. {$ALIGN MAC68K}
  46. {$LibExport+}
  47.  
  48. {$IFC FOR_SYSTEM7_ONLY }
  49. {  All utility routines defined here are callable at interrupt level.  }
  50.  
  51. TYPE
  52.     OCERecordTypeIndex                    = INTEGER;
  53.     OCEAttributeTypeIndex                = INTEGER;
  54. {
  55.  For anyone who absolutely needs a define of the body of the standard record or
  56. attribute type, use these below.  CAUTION!  All the types below are assumed to be
  57. in character set 'smRoman'.  If you try to compare these to some RString or
  58. AttributeType variable, you must take the character set code into account.  Future
  59. standard types may be defined using character sets other than 'smRoman'. 
  60. }
  61. {
  62.  All these standard definitions begin with the Apple symbol (not shown here).
  63.  
  64. NOTE:  To access these, you must call OCEGetIndRecordType or OCEGetIndAttributeType
  65. with the proper index.  These routines return pointers to the standard type.
  66. This was done so that code fragments (INITs, CDEVs, CSAMs, etc). which cannot
  67. use global data can also use these. 
  68. }
  69. {  Indices for the standard definitions for certain record types (OCERecordTypeIndex):  }
  70.  
  71. CONST
  72.     kUserRecTypeNum                = 1;                            {  "User"  }
  73.     kGroupRecTypeNum            = 2;                            {  "Group"  }
  74.     kMnMRecTypeNum                = 3;                            {  "AppleMail[tm] M&M"  }
  75.     kMnMForwarderRecTypeNum        = 4;                            {  "AppleMail[tm] Fwdr"  }
  76.     kNetworkSpecRecTypeNum        = 5;                            {  "NetworkSpec"  }
  77.     kADAPServerRecTypeNum        = 6;                            {  "ADAP Server"  }
  78.     kADAPDNodeRecTypeNum        = 7;                            {  "ADAP DNode"  }
  79.     kADAPDNodeRepRecTypeNum        = 8;                            {  "ADAP DNode Rep"  }
  80.     kServerSetupRecTypeNum        = 9;                            {  "Server Setup"  }
  81.     kDirectoryRecTypeNum        = 10;                            {  "Directory"  }
  82.     kDNodeRecTypeNum            = 11;                            {  "DNode"  }
  83.     kSetupRecTypeNum            = 12;                            {  "Setup"  }
  84.     kMSAMRecTypeNum                = 13;                            {  "MSAM"  }
  85.     kDSAMRecTypeNum                = 14;                            {  "DSAM"  }
  86.     kAttributeValueRecTypeNum    = 15;                            {  "Attribute Value"  }
  87.     kBusinessCardRecTypeNum        = 16;                            {  "Business Card"  }
  88.     kMailServiceRecTypeNum        = 17;                            {  "Mail Service"  }
  89.     kCombinedRecTypeNum            = 18;                            {  "Combined"  }
  90.     kOtherServiceRecTypeNum        = 19;                            {  "Other Service"  }
  91.     kAFPServiceRecTypeNum        = 20;                            {  "Other Service afps"  }
  92.     kFirstOCERecTypeNum            = 1;                            {  first standard OCE record type  }
  93.     kLastOCERecTypeNum            = 20;                            {  last standard OCE record type  }
  94.     kNumOCERecTypes                = 20;
  95.  
  96. {  Indices for the standard definitions for certain attribute types (OCEAttributeTypeIndex):  }
  97.     kMemberAttrTypeNum            = 1001;                            {  "Member"  }
  98.     kAdminsAttrTypeNum            = 1002;                            {  "Administrators"  }
  99.     kMailSlotsAttrTypeNum        = 1003;                            {  "mailslots"  }
  100.     kPrefMailAttrTypeNum        = 1004;                            {  "pref mailslot"  }
  101.     kAddressAttrTypeNum            = 1005;                            {  "Address"  }
  102.     kPictureAttrTypeNum            = 1006;                            {  "Picture"  }
  103.     kAuthKeyAttrTypeNum            = 1007;                            {  "auth key"  }
  104.     kTelephoneAttrTypeNum        = 1008;                            {  "Telephone"  }
  105.     kNBPNameAttrTypeNum            = 1009;                            {  "NBP Name"  }
  106.     kQMappingAttrTypeNum        = 1010;                            {  "ForwarderQMap"  }
  107.     kDialupSlotAttrTypeNum        = 1011;                            {  "DialupSlotInfo"  }
  108.     kHomeNetAttrTypeNum            = 1012;                            {  "Home Internet"  }
  109.     kCoResAttrTypeNum            = 1013;                            {  "Co-resident M&M"  }
  110.     kFwdrLocalAttrTypeNum        = 1014;                            {  "FwdrLocalRecord"  }
  111.     kConnectAttrTypeNum            = 1015;                            {  "Connected To"  }
  112.     kForeignAttrTypeNum            = 1016;                            {  "Foreign RLIs"  }
  113.     kOwnersAttrTypeNum            = 1017;                            {  "Owners"  }
  114.     kReadListAttrTypeNum        = 1018;                            {  "ReadList"  }
  115.     kWriteListAttrTypeNum        = 1019;                            {  "WriteList"  }
  116.     kDescriptorAttrTypeNum        = 1020;                            {  "Descriptor"  }
  117.     kCertificateAttrTypeNum        = 1021;                            {  "Certificate"  }
  118.     kMsgQsAttrTypeNum            = 1022;                            {  "MessageQs"  }
  119.     kPrefMsgQAttrTypeNum        = 1023;                            {  "PrefMessageQ"  }
  120.     kMasterPFAttrTypeNum        = 1024;                            {  "MasterPF"  }
  121.     kMasterNetSpecAttrTypeNum    = 1025;                            {  "MasterNetSpec"  }
  122.     kServersOfAttrTypeNum        = 1026;                            {  "Servers Of"  }
  123.     kParentCIDAttrTypeNum        = 1027;                            {  "Parent CID"  }
  124.     kNetworkSpecAttrTypeNum        = 1028;                            {  "NetworkSpec"  }
  125.     kLocationAttrTypeNum        = 1029;                            {  "Location"  }
  126.     kTimeSvrTypeAttrTypeNum        = 1030;                            {  "TimeServer Type"  }
  127.     kUpdateTimerAttrTypeNum        = 1031;                            {  "Update Timer"  }
  128.     kShadowsOfAttrTypeNum        = 1032;                            {  "Shadows Of"  }
  129.     kShadowServerAttrTypeNum    = 1033;                            {  "Shadow Server"  }
  130.     kTBSetupAttrTypeNum            = 1034;                            {  "TB Setup"  }
  131.     kMailSetupAttrTypeNum        = 1035;                            {  "Mail Setup"  }
  132.     kSlotIDAttrTypeNum            = 1036;                            {  "SlotID"  }
  133.     kGatewayFileIDAttrTypeNum    = 1037;                            {  "Gateway FileID"  }
  134.     kMailServiceAttrTypeNum        = 1038;                            {  "Mail Service"  }
  135.     kStdSlotInfoAttrTypeNum        = 1039;                            {  "Std Slot Info"  }
  136.     kAssoDirectoryAttrTypeNum    = 1040;                            {  "Asso. Directory"  }
  137.     kDirectoryAttrTypeNum        = 1041;                            {  "Directory"  }
  138.     kDirectoriesAttrTypeNum        = 1042;                            {  "Directories"  }
  139.     kSFlagsAttrTypeNum            = 1043;                            {  "SFlags"  }
  140.     kLocalNameAttrTypeNum        = 1044;                            {  "Local Name"  }
  141.     kLocalKeyAttrTypeNum        = 1045;                            {  "Local Key"  }
  142.     kDirUserRIDAttrTypeNum        = 1046;                            {  "Dir User RID"  }
  143.     kDirUserKeyAttrTypeNum        = 1047;                            {  "Dir User Key"  }
  144.     kDirNativeNameAttrTypeNum    = 1048;                            {  "Dir Native Name"  }
  145.     kCommentAttrTypeNum            = 1049;                            {  "Comment"  }
  146.     kRealNameAttrTypeNum        = 1050;                            {  "Real Name"  }
  147.     kPrivateDataAttrTypeNum        = 1051;                            {  "Private Data"  }
  148.     kDirTypeAttrTypeNum            = 1052;                            {  "Directory Type"  }
  149.     kDSAMFileAliasAttrTypeNum    = 1053;                            {  "DSAM File Alias"  }
  150.     kCanAddressToAttrTypeNum    = 1054;                            {  "Can Address To"  }
  151.     kDiscriminatorAttrTypeNum    = 1055;                            {  "Discriminator"  }
  152.     kAliasAttrTypeNum            = 1056;                            {  "Alias"  }
  153.     kParentMSAMAttrTypeNum        = 1057;                            {  "Parent MSAM"  }
  154.     kParentDSAMAttrTypeNum        = 1058;                            {  "Parent DSAM"  }
  155.     kSlotAttrTypeNum            = 1059;                            {  "Slot"  }
  156.     kAssoMailServiceAttrTypeNum    = 1060;                            {  "Asso. Mail Service"  }
  157.     kFakeAttrTypeNum            = 1061;                            {  "Fake"  }
  158.     kInheritSysAdminAttrTypeNum    = 1062;                            {  "Inherit SysAdministrators"  }
  159.     kPreferredPDAttrTypeNum        = 1063;                            {  "Preferred PD"  }
  160.     kLastLoginAttrTypeNum        = 1064;                            {  "Last Login"  }
  161.     kMailerAOMStateAttrTypeNum    = 1065;                            {  "Mailer AOM State"  }
  162.     kMailerSendOptionsAttrTypeNum = 1066;                        {  "Mailer Send Options"  }
  163.     kJoinedAttrTypeNum            = 1067;                            {  "Joined"  }
  164.     kUnconfiguredAttrTypeNum    = 1068;                            {  "Unconfigured"  }
  165.     kVersionAttrTypeNum            = 1069;                            {  "Version"  }
  166.     kLocationNamesAttrTypeNum    = 1070;                            {  "Location Names"  }
  167.     kActiveAttrTypeNum            = 1071;                            {  "Active"  }
  168.     kDeleteRequestedAttrTypeNum    = 1072;                            {  "Delete Requested"  }
  169.     kGatewayTypeAttrTypeNum        = 1073;                            {  "Gateway Type"  }
  170.     kFirstOCEAttrTypeNum        = 1001;                            {  first standard OCE attr type  }
  171.     kLastOCEAttrTypeNum            = 1073;                            {  last standard OCE attr type  }
  172.     kNumOCEAttrTypes            = 73;
  173.  
  174. {$ENDC}
  175. {$IFC FOR_SYSTEM7_ONLY }
  176. {  Miscellaneous enums:  }
  177.  
  178. CONST
  179.     kRString32Size                = 32;                            {  max size of the body field in RString32  }
  180.     kRString64Size                = 64;                            {  max size of the body field in RString64  }
  181.     kNetworkSpecMaxBytes        = 32;                            {  max size of the body field in NetworkSpec  }
  182.     kPathNameMaxBytes            = 1024;                            {  max size of the data field in PackedPathName  }
  183.     kDirectoryNameMaxBytes        = 32;                            {  max size of the body field in DirectoryName  }
  184.     kAttributeTypeMaxBytes        = 32;                            {  max size of the body field in AttributeType  }
  185.     kAttrValueMaxBytes            = 65536;                        {  max size of any attribute value  }
  186.     kRStringMaxBytes            = 256;                            {  max size (in bytes) of the body field of a recordName or recordType  }
  187.     kRStringMaxChars            = 128;                            {  max size (in chars) of the body field of a recordName or recordType  }
  188.  
  189.     kNULLDNodeNumber            = 0;                            {  Special value meaning none specified  }
  190.     kRootDNodeNumber            = 2;                            {  DNodeNum corresponding to the root of the tree  }
  191.  
  192. {
  193.  This enum is used to select the kind of RString in calls such as OCERelRString,
  194. OCEEqualRString, and OCEValidRString.
  195.  
  196. eGenericSensitive and eGenericInsensitive are enumerators that can be used if you
  197. use RStrings for things other than what you see in this file.  If you want them to
  198. be compared in a case- and diacritical-sensitive manner (c != C != Á), use
  199. eGenericSensitive.  If you want them to be compared in a case- and diacritical-
  200. insensitive manner (c = C = Á), use eGenericInensitive.
  201. WARNING:  do not use eGenericSensitive and eGenericInsensitive with catalog
  202. names, entity names, pathname parts, entity types, network specs, or attribute
  203. types!  Don't assume that you know how they should be compared!!! 
  204. }
  205.     kOCEDirName                    = 0;
  206.     kOCERecordOrDNodeName        = 1;
  207.     kOCERecordType                = 2;
  208.     kOCENetworkSpec                = 3;
  209.     kOCEAttrType                = 4;
  210.     kOCEGenericSensitive        = 5;
  211.     kOCEGenericInsensitive        = 6;
  212.  
  213.  
  214. TYPE
  215.     RStringKind                            = INTEGER;
  216. {  Values for the signature field in Discriminator  }
  217.  
  218. CONST
  219.     kDirAllKinds                = 0;
  220.     kDirADAPKind                = 'adap';
  221.     kDirPersonalDirectoryKind    = 'pdir';
  222.     kDirDSAMKind                = 'dsam';
  223.  
  224.  
  225. TYPE
  226.     OCEDirectoryKind                    = LONGINT;
  227. {  Values returned by GetDSSpecInfo()  }
  228.  
  229. CONST
  230.     kOCEInvalidDSSpec            = $3F3F3F3F;                    {  '????' could not be determined  }
  231.     kOCEDirsRootDSSpec            = 'root';                        {  root of all catalogs ("Catalogs" icon)  }
  232.     kOCEDirectoryDSSpec            = 'dire';                        {  catalog  }
  233.     kOCEDNodeDSSpec                = 'dnod';                        {  d-node  }
  234.     kOCERecordDSSpec            = 'reco';                        {  record  }
  235.     kOCEentnDSSpec                = 'entn';                        {  extensionType is 'entn'  }
  236.     kOCENOTentnDSSpec            = 'not ';                        {  extensionType is not 'entn'  }
  237.  
  238. {  Values for AttributeTag  }
  239.     typeRString                    = 'rstr';
  240.     typePackedDSSpec            = 'dspc';
  241.     typeBinary                    = 'bnry';
  242.  
  243. {
  244.  Bit flag corresponding to the canContainRecords bit.  Use it like this:
  245.     if (foo & kCanContainRecords)
  246.         then this dNode can contain records!
  247. kForeignNode is used to indicate nodes in the name hierarchy that correspond to
  248. foreign catalogs (meaning ADAP sees no clusters or DNodes beneath it, but
  249. mail routers might be able to route to clusters beneath it. 
  250. }
  251.     kCanContainRecordsBit        = 0;
  252.     kForeignNodeBit                = 1;
  253.  
  254. {  DirNodeKind  }
  255.     kCanContainRecords            = $00000001;
  256.     kForeignNode                = $00000002;
  257.  
  258.  
  259. TYPE
  260.     DirNodeKind                            = LONGINT;
  261. { *** Toolbox Control *** }
  262. {
  263.  We will have a version number and attributes for toolboxes off the aa5e trap
  264. and the S&F server trap.
  265.  
  266. This includes the OCE toolbox and S&F Server.  [Note: the S&F server will
  267. change to ONLY service ServerGateway calls --it will then be necessary to run
  268. it co-resident with an OCE toolbox].
  269.  
  270. The high order word will represent the S&F Server version number.  The low
  271. order word will represent the OCE toolbox version number.  These will be zero
  272. until the component is up and running.  It is not possible to know these
  273. a-priori. Note: there will not be a seperate version numbers for each component
  274. in the OCE toolbox or S&F server.
  275.  
  276. The above is consistent with the standard System 7.0 usage of Gestalt.
  277.  
  278. The oce tb attribute gestaltOCETBPresent implies the existence of OCE on a
  279. machine.
  280.  
  281. The OCE TB attribute gestaltOCETBAvailable implies the availablity of OCE calls.
  282.  
  283. The attribute gestaltOCESFServerAvailable implies the availablity of OCE calls
  284. available through the S&F server. This are essentially the server gateway calls.
  285.  
  286. Any (future) remaining OCE attributes may not be established correctly until
  287. the attribute gestaltOCETBAvailable is set.
  288.  
  289. The gestalt selectors and values are listed below: 
  290. }
  291.  
  292. CONST
  293.     gestaltOCEToolboxVersion    = 'ocet';                        {  OCE Toolbox version  }
  294.     gestaltOCEToolboxAttr        = 'oceu';                        {  OCE Toolbox attributes  }
  295.  
  296. {
  297.  version includes:
  298.  *  dirtb
  299.  *  authtb
  300.  *  mailtb
  301.  *  ipmtb
  302.  *  personal catalog
  303.  *  ADSPSecure
  304.  * e.g. all interfaces dependent on the aa5e trap. 
  305. }
  306.     gestaltOCETB                = $0102;                        {  OCE Toolbox version 1.02  }
  307.     gestaltSFServer                = $0100;                        {  S&F Server version 1.0  }
  308.     gestaltOCETBPresent            = $01;                            {  OCE toolbox is present, not running  }
  309.     gestaltOCETBAvailable        = $02;                            {  OCE toolbox is running and available  }
  310.     gestaltOCESFServerAvailable    = $04;                            {  S&F Server is running and available  }
  311.     gestaltOCETBNativeGlueAvailable = $10;                        {  Native PowerPC Glue routines are availible  }
  312.  
  313. {     Constants used for Transitions.  }
  314.     ATTransIPMStart                = 'ipms';
  315.     ATTransIPMShutdown            = 'ipmd';
  316.     ATTransDirStart                = 'dirs';
  317.     ATTransDirShutdown            = 'dird';
  318.     ATTransAuthStart            = 'auts';
  319.     ATTransAuthShutdown            = 'autd';
  320.     ATTransSFStart                = 's&fs';
  321.     ATTransSFShutdown            = 's&fd';
  322.  
  323. {  Some definitions for time-related parameters:  }
  324. {  Interpreted as UTC seconds since 1/1/1904  }
  325.  
  326. TYPE
  327.     UTCTime                                = LONGINT;
  328. {  seconds EAST of Greenwich  }
  329.     UTCOffset                            = LONGINT;
  330. {  This is the same as the ScriptManager script.  }
  331.     CharacterSet                        = INTEGER;
  332. { *** RString *** }
  333. {
  334.  struct RString is a maximum-sized structure.  Allocate one of these and it will
  335. hold any valid RString. 
  336. }
  337.     RStringPtr = ^RString;
  338.     RString = RECORD
  339.         charSet:                CharacterSet;
  340.         dataLength:                INTEGER;
  341.         body:                    PACKED ARRAY [0..255] OF Byte;            {  place for characters  }
  342.     END;
  343.  
  344. {  struct ProtoRString is a minimum-sized structure.  Use this for a variable-length RString.  }
  345.     ProtoRStringPtr = ^ProtoRString;
  346.     ProtoRString = RECORD
  347.         charSet:                CharacterSet;
  348.         dataLength:                INTEGER;
  349.     END;
  350.  
  351.     RStringHandle                        = ^RStringPtr;
  352.     RString64Ptr = ^RString64;
  353.     RString64 = RECORD
  354.         charSet:                CharacterSet;
  355.         dataLength:                INTEGER;
  356.         body:                    PACKED ARRAY [0..63] OF Byte;
  357.     END;
  358.  
  359.     RString32Ptr = ^RString32;
  360.     RString32 = RECORD
  361.         charSet:                CharacterSet;
  362.         dataLength:                INTEGER;
  363.         body:                    PACKED ARRAY [0..31] OF Byte;
  364.     END;
  365.  
  366. {
  367.  Standard definitions for the entity type field and attribute type
  368. have been moved to the end of the file. 
  369. }
  370. {
  371.  Copies str1 to str2.  str2Length is the size of str2, excluding header.
  372. A memFull error will be returned if that is not as large as str1->dataLength. 
  373. }
  374. FUNCTION OCECopyRString({CONST}VAR str1: RString; VAR str2: RString; str2Length: INTEGER): OSErr;
  375.     {$IFC NOT GENERATINGCFM}
  376.     INLINE $303C, $0308, $AA5C;
  377.     {$ENDC}
  378. {
  379.     Make an RString from a C string.  If the c string is bigger than rStrLength,
  380. only rStrLength bytes will be copied. (rStrLength does not include the header size) 
  381. }
  382. PROCEDURE OCECToRString(cStr: ConstCStringPtr; charSet: CharacterSet; VAR rStr: RString; rStrLength: INTEGER);
  383.     {$IFC NOT GENERATINGCFM}
  384.     INLINE $303C, $0339, $AA5C;
  385.     {$ENDC}
  386. {
  387.     Make an RString from a Pascal string.  If the Pascal string is bigger than rStrLength,
  388. only rStrLength bytes will be copied. (rStrLength does not include the header size) 
  389. }
  390. PROCEDURE OCEPToRString(pStr: Str255; charSet: CharacterSet; VAR rStr: RString; rStrLength: INTEGER);
  391.     {$IFC NOT GENERATINGCFM}
  392.     INLINE $303C, $033A, $AA5C;
  393.     {$ENDC}
  394. {
  395.     Make a Pascal string from an RString.  It's up to you to check the char set of
  396. the RString, or if the length of the RString is greater than 255 (the Pascal string's
  397. length will simply be the lower byte of the RString's length).  The StringPtr that is
  398. returned will point directly into the RString (no memory will be allocated). 
  399. }
  400. FUNCTION OCERToPString(rStr: RStringPtr): StringPtr;
  401.     {$IFC NOT GENERATINGCFM}
  402.     INLINE $303C, $033B, $AA5C;
  403.     {$ENDC}
  404. {
  405.     Check the relative equality of two RStrings.  Determines if str1 is greater than,
  406. equal to, or less than str2.  Result types for OCERelRString are defined in <OSUtils.h>
  407. (same as for RelString). 
  408. }
  409. FUNCTION OCERelRString(str1: UNIV Ptr; str2: UNIV Ptr; kind: RStringKind): INTEGER;
  410.     {$IFC NOT GENERATINGCFM}
  411.     INLINE $303C, $032D, $AA5C;
  412.     {$ENDC}
  413. {     Check for equality of two RStrings. Returns true if equal.  }
  414. FUNCTION OCEEqualRString(str1: UNIV Ptr; str2: UNIV Ptr; kind: RStringKind): BOOLEAN;
  415.     {$IFC NOT GENERATINGCFM}
  416.     INLINE $303C, $0316, $AA5C;
  417.     {$ENDC}
  418. {     Check the validity of an RString.  Returns true if the RString is valid  }
  419. FUNCTION OCEValidRString(str: UNIV Ptr; kind: RStringKind): BOOLEAN;
  420.     {$IFC NOT GENERATINGCFM}
  421.     INLINE $303C, $0338, $AA5C;
  422.     {$ENDC}
  423. { *** CreationID *** }
  424.  
  425. TYPE
  426.     CreationIDPtr = ^CreationID;
  427.     CreationID = RECORD
  428.         source:                    LONGINT;                                {  Fields definitions and usage are not defined  }
  429.         seq:                    LONGINT;
  430.     END;
  431.  
  432.     AttributeCreationID                    = CreationID;
  433.     AttributeCreationIDPtr                 = ^AttributeCreationID;
  434. {  Returns a pointer to a null CreationID .  }
  435. FUNCTION OCENullCID: CreationIDPtr;
  436.     {$IFC NOT GENERATINGCFM}
  437.     INLINE $303C, $0344, $AA5C;
  438.     {$ENDC}
  439. {  Returns a pointer to a special CreationID used within the PathFinder.  }
  440. FUNCTION OCEPathFinderCID: CreationIDPtr;
  441.     {$IFC NOT GENERATINGCFM}
  442.     INLINE $303C, $033C, $AA5C;
  443.     {$ENDC}
  444. {  Sets the CreationID to a null value.  }
  445. PROCEDURE OCESetCreationIDtoNull(VAR cid: CreationID);
  446.     {$IFC NOT GENERATINGCFM}
  447.     INLINE $303C, $032E, $AA5C;
  448.     {$ENDC}
  449. {  Copies the value of cid1 to cid2.  }
  450. PROCEDURE OCECopyCreationID({CONST}VAR cid1: CreationID; VAR cid2: CreationID);
  451.     {$IFC NOT GENERATINGCFM}
  452.     INLINE $303C, $0300, $AA5C;
  453.     {$ENDC}
  454. {  Check the equality of two CreationIDs.  }
  455. FUNCTION OCEEqualCreationID({CONST}VAR cid1: CreationID; {CONST}VAR cid2: CreationID): BOOLEAN;
  456.     {$IFC NOT GENERATINGCFM}
  457.     INLINE $303C, $030C, $AA5C;
  458.     {$ENDC}
  459. { *** NetworkSpec *** }
  460. {
  461.  For the record, a NetworkSpec is an RString with a smaller maximum size.
  462. I don't just typedef it to an RString, because I want the definition of the NetworkSpec
  463. struct to contain the max length.  But it should be possible to typecast any
  464. NetworkSpec to an RString and use all the RString utilities on it. 
  465. }
  466.  
  467. TYPE
  468.     NetworkSpecPtr = ^NetworkSpec;
  469.     NetworkSpec = RECORD
  470.         charSet:                CharacterSet;
  471.         dataLength:                INTEGER;
  472.         body:                    PACKED ARRAY [0..31] OF Byte;            {  always fixed at the max size  }
  473.     END;
  474.  
  475. { *** PackedPathName *** }
  476. {
  477.  struct PackedPathName is a maximum-sized structure.  Allocate one of
  478. these and it will hold any valid packed pathname. 
  479. }
  480.     PackedPathNamePtr = ^PackedPathName;
  481.     PackedPathName = RECORD
  482.         dataLength:                INTEGER;                                {  dataLength excludes the space for the dataLength field  }
  483.         data:                    PACKED ARRAY [0..1021] OF Byte;
  484.     END;
  485.  
  486. {
  487.  struct ProtoPackedPathName is a minimum-sized structure.  Use this
  488. for a variable-length packed PathName. 
  489. }
  490.     ProtoPackedPathNamePtr = ^ProtoPackedPathName;
  491.     ProtoPackedPathName = RECORD
  492.         dataLength:                INTEGER;                                {  dataLength excludes the space for the dataLength field  }
  493.                                                                         {  Followed by data  }
  494.     END;
  495.  
  496. {
  497. Copy the contents of path1 to path2.  path2Length is the size of path2, and must
  498. be large enough to hold a copy of path1.  A memFull error will be returned if that
  499. is not the case.
  500. }
  501. FUNCTION OCECopyPackedPathName({CONST}VAR path1: PackedPathName; VAR path2: PackedPathName; path2Length: INTEGER): OSErr;
  502.     {$IFC NOT GENERATINGCFM}
  503.     INLINE $303C, $0304, $AA5C;
  504.     {$ENDC}
  505. {
  506. Returns true if packed path pointer is nil, or is of zero length, or is of
  507. length 2 and nParts of zero.
  508. }
  509. FUNCTION OCEIsNullPackedPathName({CONST}VAR path: PackedPathName): BOOLEAN;
  510.     {$IFC NOT GENERATINGCFM}
  511.     INLINE $303C, $031D, $AA5C;
  512.     {$ENDC}
  513. {
  514. OCEUnpackPathName breaks apart the path into its component RStrings, writing string
  515. pointers into the array 'parts', which the client asserts can hold as many as
  516. 'nParts' elements. The number of parts actually found is returned.  Strings are
  517. placed in the array in order from lowest to highest.  The first pathName element
  518. beneath the root appears last.  NOTE THAT THE UNPACKED STRUCT CONTAINS POINTERS INTO
  519. THE PACKED STRUCT - DON'T DELETE OR REUSE THE PACKED STRUCT UNTIL YOU ARE FINISHED
  520. WITH THE UNPACKED STRUCT AS WELL
  521. }
  522. FUNCTION OCEUnpackPathName({CONST}VAR path: PackedPathName; VAR parts: RStringPtr; nParts: INTEGER): INTEGER;
  523.     {$IFC NOT GENERATINGCFM}
  524.     INLINE $303C, $0330, $AA5C;
  525.     {$ENDC}
  526. {
  527. OCEPackedPathNameSize computes the number of bytes of memory needed to hold a
  528. PackedPathName manufactured from the array of parts.  This length
  529. includes the length of the length field of PackedPathName, so it
  530. is safe to do a NewPtr (OCEPackedPathNameSize(...)).
  531. }
  532. FUNCTION OCEPackedPathNameSize({CONST}VAR parts: RStringPtr; nParts: INTEGER): INTEGER;
  533.     {$IFC NOT GENERATINGCFM}
  534.     INLINE $303C, $0328, $AA5C;
  535.     {$ENDC}
  536. {  OCEDNodeNameCount returns the number of RStrings contained within the path.  }
  537. FUNCTION OCEDNodeNameCount({CONST}VAR path: PackedPathName): INTEGER;
  538.     {$IFC NOT GENERATINGCFM}
  539.     INLINE $303C, $032C, $AA5C;
  540.     {$ENDC}
  541. {
  542. OCEPackPathName packs the parts into the storage provided as 'path'.  path must be
  543. large enough to hold the packed pathname.  A memFull error will be returned if
  544. pathLength is too small.  parts[0] should contain the deepest pathName element,
  545. and parts[nParts - 1] should contain the name of the first pathName element beneath
  546. the root. 
  547. }
  548. FUNCTION OCEPackPathName(VAR parts: RStringPtr; nParts: INTEGER; VAR path: PackedPathName; pathLength: INTEGER): OSErr;
  549.     {$IFC NOT GENERATINGCFM}
  550.     INLINE $303C, $0323, $AA5C;
  551.     {$ENDC}
  552. {
  553. Check the equality of two packed paths.
  554. }
  555. FUNCTION OCEEqualPackedPathName({CONST}VAR path1: PackedPathName; {CONST}VAR path2: PackedPathName): BOOLEAN;
  556.     {$IFC NOT GENERATINGCFM}
  557.     INLINE $303C, $0311, $AA5C;
  558.     {$ENDC}
  559. {
  560. OCEValidPackedPathName checks that the packed PathName is internally consistent.
  561. Returns true if it's ok.
  562. }
  563. FUNCTION OCEValidPackedPathName({CONST}VAR path: PackedPathName): BOOLEAN;
  564.     {$IFC NOT GENERATINGCFM}
  565.     INLINE $303C, $0334, $AA5C;
  566.     {$ENDC}
  567. { *** DirDiscriminator *** }
  568.  
  569. TYPE
  570.     DirDiscriminatorPtr = ^DirDiscriminator;
  571.     DirDiscriminator = RECORD
  572.         signature:                OCEDirectoryKind;
  573.         misc:                    LONGINT;
  574.     END;
  575.  
  576. {  Copies the value of disc1 to disc2.  }
  577. PROCEDURE OCECopyDirDiscriminator({CONST}VAR disc1: DirDiscriminator; VAR disc2: DirDiscriminator);
  578.     {$IFC NOT GENERATINGCFM}
  579.     INLINE $303C, $0301, $AA5C;
  580.     {$ENDC}
  581. {  Check the equality of two DirDiscriminators.  }
  582. FUNCTION OCEEqualDirDiscriminator({CONST}VAR disc1: DirDiscriminator; {CONST}VAR disc2: DirDiscriminator): BOOLEAN;
  583.     {$IFC NOT GENERATINGCFM}
  584.     INLINE $303C, $030D, $AA5C;
  585.     {$ENDC}
  586. {
  587. This structure is called RLI because it really contains all the info you
  588. need to locate a record within the entire name space.  It contains four fields.
  589. The first two are the name of the catalog and a catalog discriminator.  These
  590. two fields are used to indicate to which catalog a given record belongs.  The
  591. discriminator is used to distinguish between two different catalogs that have
  592. the same name.
  593.  
  594. The other two fields in the RLI structure are used to indicate a particular
  595. catalog node within the catalog specified by the directoryName and
  596. discriminator fields.  These fields are exactly analagous to the dirID and
  597. pathname used in HFS.  It is possible to specify a dNode just by dNodeNumber
  598. (pathname is nil), or just by pathname (dNodeNumber is set to kNULLDNodeNumber),
  599. or by a combination of the two.  The latter is called a 'partial pathname', and
  600. while it is valid in the Catalog Manager API, it is not supported by ADAP
  601. catalogs in Release 1.
  602.  
  603. Note that the path parameter does not include the catalog name, but holds
  604. the names of all the nodes on the path to the desired catalog node, starting
  605. with the catalog node and working its way up the tree.
  606. }
  607. { *** RLI *** }
  608.  
  609. TYPE
  610.     DirectoryNamePtr = ^DirectoryName;
  611.     DirectoryName = RECORD
  612.         charSet:                CharacterSet;
  613.         dataLength:                INTEGER;
  614.         body:                    PACKED ARRAY [0..31] OF Byte;            {  space for catalog name  }
  615.     END;
  616.  
  617. {  Catalog node number  }
  618.     DNodeNum                            = LONGINT;
  619.     RLIPtr = ^RLI;
  620.     RLI = RECORD
  621.         directoryName:            DirectoryNamePtr;                        {  pointer to the name of the catalog root  }
  622.         discriminator:            DirDiscriminator;                        {  used to discriminate between dup catalog names  }
  623.         dNodeNumber:            DNodeNum;                                {  number of the node  }
  624.         path:                    PackedPathNamePtr;                        {  old-style RLI  }
  625.     END;
  626.  
  627. {
  628. Create a new RLI from the catalog name, discriminator, DNode number, and
  629. PackedPathName.  You must allocate the storage for the RLI and pass in a pointer
  630. to it.
  631. }
  632. PROCEDURE OCENewRLI(VAR newRLI: RLI; {CONST}VAR dirName: DirectoryName; VAR discriminator: DirDiscriminator; dNodeNumber: DNodeNum; {CONST}VAR path: PackedPathName);
  633.     {$IFC NOT GENERATINGCFM}
  634.     INLINE $303C, $031F, $AA5C;
  635.     {$ENDC}
  636. {
  637. Duplicate the contents of rli1 to rli2.  No errors are returned. This
  638. simply copies the pointers to the catalog name and path, wiping out any pointer
  639. that you might have had in there.
  640. }
  641. PROCEDURE OCEDuplicateRLI({CONST}VAR rli1: RLI; VAR rli2: RLI);
  642.     {$IFC NOT GENERATINGCFM}
  643.     INLINE $303C, $030B, $AA5C;
  644.     {$ENDC}
  645. {
  646. Copy the contents of rli1 to rli2.  rli2 must already contain
  647. pointers to structures large enough to hold copies of the corresponding
  648. fields from rli1.  A memFull error will be returned if that is not the case.
  649. So if you allocate a brand new empty destination, you must at least set up
  650. its length fields.
  651. }
  652. FUNCTION OCECopyRLI({CONST}VAR rli1: RLI; VAR rli2: RLI): OSErr;
  653.     {$IFC NOT GENERATINGCFM}
  654.     INLINE $303C, $0307, $AA5C;
  655.     {$ENDC}
  656. {
  657. Check the equality of two RLIs.  This will take into account differences
  658. in the case and diacriticals of the directoryName and the PathName.
  659. NOTE THAT THIS WILL FAIL IF rli1 CONTAINS A DNODENUMBER AND A NIL PATHNAME,
  660. AND rli2 CONTAINS kNULLDNodeNumber AND A NON-NIL PATHNAME.  IN OTHER WORDS,
  661. THE TWO rlis MUST BE OF THE SAME FORM TO CHECK FOR EQUALITY.
  662. The one exception is that if the pathname is nil, a dNodeNumber of zero and
  663. kRootDNodeNumber will be treated as equal.
  664. }
  665. FUNCTION OCEEqualRLI({CONST}VAR rli1: RLI; {CONST}VAR rli2: RLI): BOOLEAN;
  666.     {$IFC NOT GENERATINGCFM}
  667.     INLINE $303C, $0315, $AA5C;
  668.     {$ENDC}
  669. {
  670. Check the validity of an RLI.  This checks that the catalog name length
  671. is within bounds, and the packed pathname (if specified) is valid.
  672. }
  673. FUNCTION OCEValidRLI({CONST}VAR theRLI: RLI): BOOLEAN;
  674.     {$IFC NOT GENERATINGCFM}
  675.     INLINE $303C, $0337, $AA5C;
  676.     {$ENDC}
  677. { *** PackedRLI *** }
  678. {
  679. struct PackedRLI is a maximum-sized structure.  Allocate one of
  680. these and it will hold any valid packed pathname.
  681. }
  682.  
  683. CONST
  684.     kRLIMaxBytes                = 1296;
  685.  
  686.  
  687. TYPE
  688.     PackedRLIPtr = ^PackedRLI;
  689.     PackedRLI = RECORD
  690.         dataLength:                INTEGER;                                {  dataLength excludes the space for the dataLength field  }
  691.         data:                    PACKED ARRAY [0..1295] OF Byte;
  692.     END;
  693.  
  694. {
  695. struct ProtoPackedRLI is a minimum-sized structure.  Use this
  696. for a variable-length packed RLI.
  697. }
  698.     ProtoPackedRLIPtr = ^ProtoPackedRLI;
  699.     ProtoPackedRLI = RECORD
  700.         dataLength:                INTEGER;                                {  dataLength excludes the space for the dataLength field  }
  701.                                                                         {  Followed by data  }
  702.     END;
  703.  
  704. {
  705. Copy the contents of prli1 to prli2.  prli2Length is the size of prli2, and must
  706. be large enough to hold a copy of prli1.  A memFull error will be returned if that
  707. is not the case.
  708. }
  709. FUNCTION OCECopyPackedRLI({CONST}VAR prli1: PackedRLI; VAR prli2: PackedRLI; prli2Length: INTEGER): OSErr;
  710.     {$IFC NOT GENERATINGCFM}
  711.     INLINE $303C, $0305, $AA5C;
  712.     {$ENDC}
  713. {
  714. OCEUnpackRLI breaks apart the prli into its components, writing pointers into
  715. the rli structure.  NOTE THAT THE UNPACKED STRUCT CONTAINS POINTERS INTO THE
  716. PACKED STRUCT - DON'T DELETE OR REUSE THE PACKED STRUCT UNTIL YOU ARE FINISHED
  717. WITH THE UNPACKED STRUCT AS WELL
  718. }
  719. PROCEDURE OCEUnpackRLI({CONST}VAR prli: PackedRLI; VAR theRLI: RLI);
  720.     {$IFC NOT GENERATINGCFM}
  721.     INLINE $303C, $0331, $AA5C;
  722.     {$ENDC}
  723. {
  724. OCEPackedRLISize computes the number of bytes of memory needed to hold a
  725. PackedRLI manufactured from an RLI.  This length
  726. includes the length of the length field of PackedRLI, so it
  727. is safe to do a NewPtr (OCEPackedRLISize(...)).
  728. }
  729. FUNCTION OCEPackedRLISize({CONST}VAR theRLI: RLI): INTEGER;
  730.     {$IFC NOT GENERATINGCFM}
  731.     INLINE $303C, $032A, $AA5C;
  732.     {$ENDC}
  733. {
  734. OCEPackRLI packs the RLI into the storage provided as 'prli'.  prli must be
  735. large enough to hold the packed RLI.  A memFull error will be returned if
  736. prliLength is too small.
  737. }
  738. FUNCTION OCEPackRLI({CONST}VAR theRLI: RLI; VAR prli: PackedRLI; prliLength: INTEGER): OSErr;
  739.     {$IFC NOT GENERATINGCFM}
  740.     INLINE $303C, $0324, $AA5C;
  741.     {$ENDC}
  742. {
  743. OCEPackedRLIPartsSize computes the number of bytes of memory needed to hold a
  744. PackedRLI manufactured from the parts of an RLI.  This length
  745. includes the length of the length field of PackedRLI, so it
  746. is safe to do a NewPtr (OCEPackedRLIPartsSize(...)).
  747. }
  748. FUNCTION OCEPackedRLIPartsSize({CONST}VAR dirName: DirectoryName; VAR parts: RStringPtr; nParts: INTEGER): INTEGER;
  749.     {$IFC NOT GENERATINGCFM}
  750.     INLINE $303C, $0329, $AA5C;
  751.     {$ENDC}
  752. {
  753. OCEPackRLIParts packs the parts of an RLI into the storage provided as 'prli'.
  754. prli must be large enough to hold the packed RLI.  A memFull error will be returned
  755. if prliLength is too small.
  756. }
  757. FUNCTION OCEPackRLIParts({CONST}VAR dirName: DirectoryName; {CONST}VAR discriminator: DirDiscriminator; dNodeNumber: DNodeNum; VAR parts: RStringPtr; nParts: INTEGER; VAR prli: PackedRLI; prliLength: INTEGER): OSErr;
  758.     {$IFC NOT GENERATINGCFM}
  759.     INLINE $303C, $0325, $AA5C;
  760.     {$ENDC}
  761. {
  762. Check the equality of two packed prlis.
  763. }
  764. FUNCTION OCEEqualPackedRLI({CONST}VAR prli1: PackedRLI; {CONST}VAR prli2: PackedRLI): BOOLEAN;
  765.     {$IFC NOT GENERATINGCFM}
  766.     INLINE $303C, $0313, $AA5C;
  767.     {$ENDC}
  768. {
  769. Check the validity of a packed RLI.  This checks that the catalog name length
  770. is within bounds, and the packed pathname (if specified) is valid.
  771. }
  772. FUNCTION OCEValidPackedRLI({CONST}VAR prli: PackedRLI): BOOLEAN;
  773.     {$IFC NOT GENERATINGCFM}
  774.     INLINE $303C, $0336, $AA5C;
  775.     {$ENDC}
  776. {
  777. If this packed RLI describes a Personal Catalog, this call will return a pointer
  778. to an alias record that can be used to find the actual file.  Otherwise, it returns nil.
  779. }
  780. FUNCTION OCEExtractAlias({CONST}VAR prli: PackedRLI): AliasPtr;
  781.     {$IFC NOT GENERATINGCFM}
  782.     INLINE $303C, $0318, $AA5C;
  783.     {$ENDC}
  784. {
  785. This call returns a pointer to a packed RLI that represents the "Catalogs" icon, or
  786. the root of all catalogs.  It is used in the CollabPack.
  787. }
  788. FUNCTION OCEGetDirectoryRootPackedRLI: PackedRLIPtr;
  789.     {$IFC NOT GENERATINGCFM}
  790.     INLINE $303C, $0346, $AA5C;
  791.     {$ENDC}
  792. { *** LocalRecordID *** }
  793.  
  794. TYPE
  795.     LocalRecordIDPtr = ^LocalRecordID;
  796.     LocalRecordID = RECORD
  797.         cid:                    CreationID;
  798.         recordName:                RStringPtr;
  799.         recordType:                RStringPtr;
  800.     END;
  801.  
  802. {  Create a LocalRecordID from a name, type, and CreationID  }
  803. PROCEDURE OCENewLocalRecordID({CONST}VAR recordName: RString; {CONST}VAR recordType: RString; {CONST}VAR cid: CreationID; VAR lRID: LocalRecordID);
  804.     {$IFC NOT GENERATINGCFM}
  805.     INLINE $303C, $031E, $AA5C;
  806.     {$ENDC}
  807. {
  808. Copy LocalRecordID lRID1 to LocalRecordID lRID2.  lRID2 must already contain
  809. pointers to RString structures large enough to hold copies of the corresponding
  810. fields from lRID1.  A memFull error will be returned if that is not the case.
  811. So if you allocate a brand new empty destination, you must at least set up
  812. its length field.
  813. }
  814. FUNCTION OCECopyLocalRecordID({CONST}VAR lRID1: LocalRecordID; VAR lRID2: LocalRecordID): OSErr;
  815.     {$IFC NOT GENERATINGCFM}
  816.     INLINE $303C, $0302, $AA5C;
  817.     {$ENDC}
  818. {
  819. Check the equality of two local RIDs.
  820. }
  821. FUNCTION OCEEqualLocalRecordID({CONST}VAR lRID1: LocalRecordID; {CONST}VAR lRID2: LocalRecordID): BOOLEAN;
  822.     {$IFC NOT GENERATINGCFM}
  823.     INLINE $303C, $030F, $AA5C;
  824.     {$ENDC}
  825. { *** ShortRecordID *** }
  826.  
  827. TYPE
  828.     ShortRecordIDPtr = ^ShortRecordID;
  829.     ShortRecordID = RECORD
  830.         rli:                    PackedRLIPtr;
  831.         cid:                    CreationID;
  832.     END;
  833.  
  834. {  Create a ShortRecordID from an RLI struct and a CreationID  }
  835. PROCEDURE OCENewShortRecordID({CONST}VAR theRLI: PackedRLI; {CONST}VAR cid: CreationID; sRID: ShortRecordIDPtr);
  836.     {$IFC NOT GENERATINGCFM}
  837.     INLINE $303C, $0321, $AA5C;
  838.     {$ENDC}
  839. {
  840. Copy ShortRecordID sRID1 to ShortRecordID sRID2.  sRID2 must already contain
  841. pointers to structures large enough to hold copies of the corresponding
  842. fields from sRID1.  A memFull error will be returned if that is not the case.
  843. So if you allocate a brand new empty destination, you must at least set up
  844. its length fields.
  845. }
  846. FUNCTION OCECopyShortRecordID({CONST}VAR sRID1: ShortRecordID; VAR sRID2: ShortRecordID): OSErr;
  847.     {$IFC NOT GENERATINGCFM}
  848.     INLINE $303C, $030A, $AA5C;
  849.     {$ENDC}
  850. {
  851. Check the equality of two short RIDs.
  852. }
  853. FUNCTION OCEEqualShortRecordID({CONST}VAR sRID1: ShortRecordID; {CONST}VAR sRID2: ShortRecordID): BOOLEAN;
  854.     {$IFC NOT GENERATINGCFM}
  855.     INLINE $303C, $0317, $AA5C;
  856.     {$ENDC}
  857. { *** RecordID *** }
  858.  
  859. TYPE
  860.     RecordIDPtr = ^RecordID;
  861.     RecordID = RECORD
  862.         rli:                    PackedRLIPtr;                            {  pointer to a packed rli structure  }
  863.         local:                    LocalRecordID;
  864.     END;
  865.  
  866. {
  867.     Create a RecordID from a packed RLI struct and a LocalRecordID.
  868. This doesn't allocate any new space; the RecordID points to the same
  869. packed RLI struct and the same name and type RStrings. 
  870. }
  871. PROCEDURE OCENewRecordID({CONST}VAR theRLI: PackedRLI; {CONST}VAR lRID: LocalRecordID; VAR rid: RecordID);
  872.     {$IFC NOT GENERATINGCFM}
  873.     INLINE $303C, $0320, $AA5C;
  874.     {$ENDC}
  875. {
  876. Copy RecordID RID1 to RecordID RID2.  RID2 must already contain
  877. pointers to structures large enough to hold copies of the corresponding
  878. fields from lRID1.  A memFull error will be returned if that is not the case.
  879. So if you allocate a brand new empty destination, you must at least set up
  880. its length fields.
  881. }
  882. FUNCTION OCECopyRecordID({CONST}VAR rid1: RecordID; {CONST}VAR rid2: RecordID): OSErr;
  883.     {$IFC NOT GENERATINGCFM}
  884.     INLINE $303C, $0309, $AA5C;
  885.     {$ENDC}
  886. {     Check the equality of two RIDs.  }
  887. FUNCTION OCEEqualRecordID({CONST}VAR rid1: RecordID; {CONST}VAR rid2: RecordID): BOOLEAN;
  888.     {$IFC NOT GENERATINGCFM}
  889.     INLINE $303C, $0314, $AA5C;
  890.     {$ENDC}
  891. { *** PackedRecordID *** }
  892. {
  893. struct PackedRecordID is a maximum-sized structure.  Allocate one of
  894. these and it will hold any valid packed RecordID.
  895. }
  896.  
  897. CONST
  898.     kPackedRecordIDMaxBytes        = 1824;
  899.  
  900.  
  901. TYPE
  902.     PackedRecordIDPtr = ^PackedRecordID;
  903.     PackedRecordID = RECORD
  904.         dataLength:                INTEGER;                                {  dataLength excludes the space for the dataLength field  }
  905.         data:                    PACKED ARRAY [0..1823] OF Byte;
  906.     END;
  907.  
  908. {
  909. struct ProtoPackedRecordID is a minimum-sized structure.  Use this
  910. for a variable-length packed RecordID.
  911. }
  912.     ProtoPackedRecordIDPtr = ^ProtoPackedRecordID;
  913.     ProtoPackedRecordID = RECORD
  914.         dataLength:                INTEGER;                                {  dataLength excludes the space for the dataLength field  }
  915.                                                                         {  Followed by data  }
  916.     END;
  917.  
  918. {
  919. Copy PackedRecordID pRID1 to PackedRecordID pRID2.  pRID2 must already contain
  920. pointers to structures large enough to hold copies of the corresponding
  921. fields from pRID1.  A memFull error will be returned if that is not the case.
  922. pRID2Length is the number of bytes that can be put into pRID2, not counting the
  923. packed RecordID header.
  924. }
  925. FUNCTION OCECopyPackedRecordID({CONST}VAR pRID1: PackedRecordID; {CONST}VAR pRID2: PackedRecordID; pRID2Length: INTEGER): OSErr;
  926.     {$IFC NOT GENERATINGCFM}
  927.     INLINE $303C, $0306, $AA5C;
  928.     {$ENDC}
  929. {
  930. Create a RecordID from a PackedRecordID.
  931. NOTE THAT THE UNPACKED STRUCT CONTAINS POINTERS INTO THE PACKED STRUCT - DON'T DELETE
  932. OR REUSE THE PACKED STRUCT UNTIL YOU ARE FINISHED WITH THE UNPACKED STRUCT AS WELL
  933. }
  934. PROCEDURE OCEUnpackRecordID({CONST}VAR pRID: PackedRecordID; VAR rid: RecordID);
  935.     {$IFC NOT GENERATINGCFM}
  936.     INLINE $303C, $0332, $AA5C;
  937.     {$ENDC}
  938. {
  939. Create a PackedRecordID from a RecordID.  pRID must be large enough to contain
  940. the packed RecordID.  A memFull error will be returned if that is not the case.
  941. packedRecordIDLength is the number of bytes that can be put into pRID, not
  942. counting the header.
  943. }
  944. FUNCTION OCEPackRecordID({CONST}VAR rid: RecordID; VAR pRID: PackedRecordID; packedRecordIDLength: INTEGER): OSErr;
  945.     {$IFC NOT GENERATINGCFM}
  946.     INLINE $303C, $0326, $AA5C;
  947.     {$ENDC}
  948. {
  949. Compute the number of bytes of memory needed to hold a RecordID when packed. This
  950. length includes the length of the length field of PackedRecordID, so it
  951. is safe to do a NewPtr (OCEPackedRecordIDSize(...)).
  952. }
  953. FUNCTION OCEPackedRecordIDSize({CONST}VAR rid: RecordID): INTEGER;
  954.     {$IFC NOT GENERATINGCFM}
  955.     INLINE $303C, $032B, $AA5C;
  956.     {$ENDC}
  957. {
  958. Check the equality of two packed RIDs.
  959. }
  960. FUNCTION OCEEqualPackedRecordID({CONST}VAR pRID1: PackedRecordID; {CONST}VAR pRID2: PackedRecordID): BOOLEAN;
  961.     {$IFC NOT GENERATINGCFM}
  962.     INLINE $303C, $0312, $AA5C;
  963.     {$ENDC}
  964. {  OCEValidPackedRecordID checks the validity of a packed record ID.  }
  965. FUNCTION OCEValidPackedRecordID({CONST}VAR pRID: PackedRecordID): BOOLEAN;
  966.     {$IFC NOT GENERATINGCFM}
  967.     INLINE $303C, $0335, $AA5C;
  968.     {$ENDC}
  969. { *** DSSpec *** }
  970.  
  971. TYPE
  972.     DSSpecPtr = ^DSSpec;
  973.     DSSpec = RECORD
  974.         entitySpecifier:        RecordIDPtr;
  975.         extensionType:            OSType;
  976.         extensionSize:            INTEGER;
  977.         extensionValue:            Ptr;
  978.     END;
  979.  
  980. {
  981. struct PackedDSSpec is NOT a maximum-sized structure.  Allocate one of
  982. these and it will hold any valid packed RecordID, but not necessarily any additional
  983. data.
  984. }
  985.  
  986. CONST
  987.     kPackedDSSpecMaxBytes        = 1832;
  988.  
  989.  
  990. TYPE
  991.     PackedDSSpecPtr = ^PackedDSSpec;
  992.     PackedDSSpec = RECORD
  993.         dataLength:                INTEGER;                                {  dataLength excludes the space for the dataLength field  }
  994.         data:                    PACKED ARRAY [0..1831] OF Byte;
  995.     END;
  996.  
  997.     PackedDSSpecHandle                    = ^PackedDSSpecPtr;
  998. {
  999. struct ProtoPackedDSSpec is a minimum-sized structure.  Use this
  1000. for a variable-length packed DSSpec.
  1001. }
  1002.     ProtoPackedDSSpecPtr = ^ProtoPackedDSSpec;
  1003.     ProtoPackedDSSpec = RECORD
  1004.         dataLength:                INTEGER;                                {  dataLength excludes the space for the dataLength field  }
  1005.                                                                         {  Followed by data  }
  1006.     END;
  1007.  
  1008. {
  1009. Copy PackedDSSpec pdss1 to PackedDSSpec pdss2.  pdss2 must already contain
  1010. pointers to structures large enough to hold copies of the corresponding
  1011. fields from pdss1.  A memFull error will be returned if that is not the case.
  1012. pdss2Length is the number of bytes that can be put into pdss2, not counting the
  1013. packed DSSpec header.
  1014. }
  1015. FUNCTION OCECopyPackedDSSpec({CONST}VAR pdss1: PackedDSSpec; {CONST}VAR pdss2: PackedDSSpec; pdss2Length: INTEGER): OSErr;
  1016.     {$IFC NOT GENERATINGCFM}
  1017.     INLINE $303C, $0303, $AA5C;
  1018.     {$ENDC}
  1019. {
  1020. Create a DSSpec from a PackedDSSpec.
  1021. NOTE THAT THE UNPACKED STRUCT CONTAINS POINTERS INTO THE PACKED STRUCT - DON'T DELETE
  1022. OR REUSE THE PACKED STRUCT UNTIL YOU ARE FINISHED WITH THE UNPACKED STRUCT AS WELL.
  1023. A pointer to the extension is returned in dss->extensionValue, and the length of that
  1024. extension is returned in dss->extensionSize.  If there is no extension, dss->extensionValue will
  1025. be set to nil.  This routine will unpack the RecordID (if any) into rid, unpack the rest
  1026. into dss, and set dss->entitySpecifier to rid.
  1027. }
  1028. PROCEDURE OCEUnpackDSSpec({CONST}VAR pdss: PackedDSSpec; VAR dss: DSSpec; VAR rid: RecordID);
  1029.     {$IFC NOT GENERATINGCFM}
  1030.     INLINE $303C, $032F, $AA5C;
  1031.     {$ENDC}
  1032. {
  1033. Create a PackedDSSpec from a DSSpec.  pdss must be large enough to
  1034. contain the packed RecordID and any extension.  A memFull error will be returned if that
  1035. is not the case.  pdssLength is the number of bytes that can be put into pdss,
  1036. not counting the header.
  1037. }
  1038. FUNCTION OCEPackDSSpec({CONST}VAR dss: DSSpec; VAR pdss: PackedDSSpec; pdssLength: INTEGER): OSErr;
  1039.     {$IFC NOT GENERATINGCFM}
  1040.     INLINE $303C, $0322, $AA5C;
  1041.     {$ENDC}
  1042. {
  1043. Compute the number of bytes of memory needed to hold a DSSpec when packed. This
  1044. length includes the length of the length field of PackedDSSpec, so it
  1045. is safe to do a NewPtr (OCEPackedDSSpecSize(...)).
  1046. }
  1047. FUNCTION OCEPackedDSSpecSize({CONST}VAR dss: DSSpec): INTEGER;
  1048.     {$IFC NOT GENERATINGCFM}
  1049.     INLINE $303C, $0327, $AA5C;
  1050.     {$ENDC}
  1051. {
  1052.     Check the equality of two DSSpecs.  This compares all fields, even the
  1053. extension (unless extensionSize == 0).  The extensions are compared in a case-insensitive and
  1054. diacrit-insensitive manner. 
  1055. }
  1056. FUNCTION OCEEqualDSSpec({CONST}VAR pdss1: DSSpec; {CONST}VAR pdss2: DSSpec): BOOLEAN;
  1057.     {$IFC NOT GENERATINGCFM}
  1058.     INLINE $303C, $030E, $AA5C;
  1059.     {$ENDC}
  1060. {
  1061.     Check the equality of two PackedDSSpecs.  This compares all fields, even the
  1062. extension (unless extensionSize == 0).  The extensions are compared in a case-insensitive and
  1063. diacrit-insensitive manner. 
  1064. }
  1065. FUNCTION OCEEqualPackedDSSpec({CONST}VAR pdss1: PackedDSSpec; {CONST}VAR pdss2: PackedDSSpec): BOOLEAN;
  1066.     {$IFC NOT GENERATINGCFM}
  1067.     INLINE $303C, $0310, $AA5C;
  1068.     {$ENDC}
  1069. {
  1070. Check the validity of a PackedDSSpec.  If extensionType is
  1071. 'entn', pdss must contain a valid entitySpecifier.  For all other extensionTypes, a nil
  1072. entitySpecifier is valid, but if non-nil, it will be checked for validity.  No check
  1073. is made on the extension.
  1074. }
  1075. FUNCTION OCEValidPackedDSSpec({CONST}VAR pdss: PackedDSSpec): BOOLEAN;
  1076.     {$IFC NOT GENERATINGCFM}
  1077.     INLINE $303C, $0333, $AA5C;
  1078.     {$ENDC}
  1079. {
  1080. Return info about a DSSpec.  This routine does not check validity.  If the
  1081. DSSpec has no extension, we determine whether it represents the root of all
  1082. catalogs, a single catalog, a DNode, or a Record.  Else it is invalid.
  1083. If the DSSpec has an extension, we simply return the extension type.
  1084. }
  1085. FUNCTION OCEGetDSSpecInfo({CONST}VAR spec: DSSpec): LONGINT;
  1086.     {$IFC NOT GENERATINGCFM}
  1087.     INLINE $303C, $0319, $AA5C;
  1088.     {$ENDC}
  1089. {  OCEGetExtensionType returns the extensionType imbedded in the PackedDSSpec.  }
  1090. FUNCTION OCEGetExtensionType({CONST}VAR pdss: PackedDSSpec): LONGINT;
  1091.     {$IFC NOT GENERATINGCFM}
  1092.     INLINE $303C, $031C, $AA5C;
  1093.     {$ENDC}
  1094. {
  1095. OCEStreamPackedDSSpec streams (flattens) a catalog object a little at a time by
  1096. calling the DSSpecStreamer routine that you provide.
  1097. }
  1098.  
  1099. TYPE
  1100.     DSSpecStreamerProcPtr = ProcPtr;  { FUNCTION DSSpecStreamer(buffer: UNIV Ptr; count: LONGINT; eof: BOOLEAN; userData: LONGINT): OSErr; }
  1101.  
  1102.     DSSpecStreamerUPP = UniversalProcPtr;
  1103.  
  1104. CONST
  1105.     uppDSSpecStreamerProcInfo = $000037E0;
  1106.  
  1107. FUNCTION NewDSSpecStreamerProc(userRoutine: DSSpecStreamerProcPtr): DSSpecStreamerUPP;
  1108.     {$IFC NOT GENERATINGCFM }
  1109.     INLINE $2E9F;
  1110.     {$ENDC}
  1111.  
  1112. FUNCTION CallDSSpecStreamerProc(buffer: UNIV Ptr; count: LONGINT; eof: BOOLEAN; userData: LONGINT; userRoutine: DSSpecStreamerUPP): OSErr;
  1113.     {$IFC NOT GENERATINGCFM}
  1114.     INLINE $205F, $4E90;
  1115.     {$ENDC}
  1116.  
  1117. TYPE
  1118.     DSSpecStreamer                        = DSSpecStreamerUPP;
  1119. FUNCTION OCEStreamPackedDSSpec({CONST}VAR dss: DSSpec; stream: DSSpecStreamer; userData: LONGINT; VAR actualCount: LONGINT): OSErr;
  1120.     {$IFC NOT GENERATINGCFM}
  1121.     INLINE $303C, $033D, $AA5C;
  1122.     {$ENDC}
  1123. { *** AttributeType *** }
  1124. {
  1125. For the record, an AttributeType is an RString with a smaller maximum size.
  1126. I don't just typedef it to an RString, because I want the definition of the AttributeType
  1127. struct to contain the max length, because I need to include it in the Attribute struct
  1128. below.  But it should be possible to typecast any AttributeType to an RString and use
  1129. all the RString utilities on it.
  1130. }
  1131.  
  1132. TYPE
  1133.     AttributeTypePtr = ^AttributeType;
  1134.     AttributeType = RECORD
  1135.         charSet:                CharacterSet;
  1136.         dataLength:                INTEGER;
  1137.         body:                    PACKED ARRAY [0..31] OF Byte;            {  always fixed at the max size  }
  1138.     END;
  1139.  
  1140. {  Miscellaneous defines:  (these cannot be made into enums)  }
  1141.  
  1142. CONST
  1143.     kMinPackedRStringLength        = 4;
  1144.  
  1145.     kMinPackedRLISize            = 20;
  1146.  
  1147. { *** AttributeValue *** }
  1148. {  same class as is used in AppleEvents  }
  1149.  
  1150. TYPE
  1151.     AttributeTag                        = DescType;
  1152.     AttributeValuePtr = ^AttributeValue;
  1153.     AttributeValue = RECORD
  1154.         tag:                    AttributeTag;
  1155.         dataLength:                LONGINT;
  1156.         bytes:                    Ptr;
  1157.     END;
  1158.  
  1159. { *** Attribute *** }
  1160.     AttributePtr = ^Attribute;
  1161.     Attribute = RECORD
  1162.         attributeType:            AttributeType;
  1163.         cid:                    AttributeCreationID;
  1164.         value:                    AttributeValue;
  1165.     END;
  1166.  
  1167. FUNCTION OCEGetIndRecordType(stringIndex: OCERecordTypeIndex): RStringPtr;
  1168.     {$IFC NOT GENERATINGCFM}
  1169.     INLINE $303C, $031B, $AA5C;
  1170.     {$ENDC}
  1171. FUNCTION OCEGetIndAttributeType(stringIndex: OCEAttributeTypeIndex): AttributeTypePtr;
  1172.     {$IFC NOT GENERATINGCFM}
  1173.     INLINE $303C, $031A, $AA5C;
  1174.     {$ENDC}
  1175.  
  1176. CONST
  1177.     _oceTBDispatch                = $AA5E;
  1178.  
  1179. {
  1180. ***************************************************************************************
  1181.    PLEASE NOTE! ROUTINES HAVE MOVED TO THIS HEADER!
  1182.  
  1183.    OCESizePackedRecipient, OCEPackRecipient, OCEUnpackRecipient, OCEStreamRecipient,
  1184.    OCEGetRecipientType, and OCESetRecipientType have moved to the OCE header file.
  1185.    The OCEMessaging header includes the OCE header, so no changes to your code are
  1186.    required.
  1187.  
  1188. ***************************************************************************************
  1189. }
  1190.  
  1191. TYPE
  1192.     OCERecipient                        = DSSpec;
  1193.     OCERecipientPtr                     = ^OCERecipient;
  1194.  
  1195. CONST
  1196.     kOCESizePackedRecipient        = 830;
  1197.     kOCEPackRecipient            = 831;
  1198.     kOCEUnpackRecipient            = 832;
  1199.     kOCEStreamRecipient            = 833;
  1200.     kOCEGetRecipientType        = 834;
  1201.     kOCESetRecipientType        = 835;
  1202.  
  1203. {
  1204. Compute the space that a OCERecipient would take if it were in packed
  1205. form.  [Note: does NOT even pad extensionSize, so you may get an odd #back out]
  1206. Safe to pass dereferenced handle(s).
  1207. }
  1208. FUNCTION OCESizePackedRecipient({CONST}VAR rcpt: OCERecipient): INTEGER;
  1209.     {$IFC NOT GENERATINGCFM}
  1210.     INLINE $303C, $033E, $AA5C;
  1211.     {$ENDC}
  1212. {
  1213. Take an OCERecipient (scatter) and (gather) stream into the specified
  1214. buffer.  It is assumed that there is sufficient space in the buffer (that is
  1215. OCESizePackedRecipient).  Safe to pass dereferenced handle(s).
  1216. }
  1217. FUNCTION OCEPackRecipient({CONST}VAR rcpt: OCERecipient; buffer: UNIV Ptr): INTEGER;
  1218.     {$IFC NOT GENERATINGCFM}
  1219.     INLINE $303C, $033F, $AA5C;
  1220.     {$ENDC}
  1221. {
  1222. Take a packed OCERecipient and cast a the OCERecipient frame over it. Returns
  1223. amBadDestId if it doesn't look like an OCERecipient. Safe to pass dereferenced
  1224. handle(s).
  1225. }
  1226. FUNCTION OCEUnpackRecipient(buffer: UNIV Ptr; VAR rcpt: OCERecipient; VAR entitySpecifier: RecordID): OSErr;
  1227.     {$IFC NOT GENERATINGCFM}
  1228.     INLINE $303C, $0340, $AA5C;
  1229.     {$ENDC}
  1230. {
  1231. Take an OCERecipient (scatter) and (gather) stream using the specified
  1232. function.  Safe to pass dereferenced handle(s).  If streamer function returns
  1233. OCEError OCEStreamRecipient stops execution and passes the error back to the caller
  1234. }
  1235.  
  1236. TYPE
  1237.     OCERecipientStreamerProcPtr = ProcPtr;  { FUNCTION OCERecipientStreamer(buffer: UNIV Ptr; count: LONGINT; eof: BOOLEAN; userData: LONGINT): OSErr; }
  1238.  
  1239.     OCERecipientStreamerUPP = UniversalProcPtr;
  1240.  
  1241. CONST
  1242.     uppOCERecipientStreamerProcInfo = $000037E0;
  1243.  
  1244. FUNCTION NewOCERecipientStreamerProc(userRoutine: OCERecipientStreamerProcPtr): OCERecipientStreamerUPP;
  1245.     {$IFC NOT GENERATINGCFM }
  1246.     INLINE $2E9F;
  1247.     {$ENDC}
  1248.  
  1249. FUNCTION CallOCERecipientStreamerProc(buffer: UNIV Ptr; count: LONGINT; eof: BOOLEAN; userData: LONGINT; userRoutine: OCERecipientStreamerUPP): OSErr;
  1250.     {$IFC NOT GENERATINGCFM}
  1251.     INLINE $205F, $4E90;
  1252.     {$ENDC}
  1253.  
  1254. TYPE
  1255.     OCERecipientStreamer                = OCERecipientStreamerUPP;
  1256. FUNCTION OCEStreamRecipient({CONST}VAR rcpt: OCERecipient; stream: OCERecipientStreamer; userData: LONGINT; VAR actualCount: LONGINT): OSErr;
  1257.     {$IFC NOT GENERATINGCFM}
  1258.     INLINE $303C, $0341, $AA5C;
  1259.     {$ENDC}
  1260. {  Get the OCERecipient's extensionType. Safe to pass dereferenced handle(s). }
  1261. FUNCTION OCEGetRecipientType({CONST}VAR cid: CreationID): LONGINT;
  1262.     {$IFC NOT GENERATINGCFM}
  1263.     INLINE $303C, $0342, $AA5C;
  1264.     {$ENDC}
  1265. {
  1266. Set the OCERecipient's extensionType in the specified cid.  (Note: we do NOT
  1267. check for a nil pointer).  If the extensionType is 'entn', the cid is assumed
  1268. to be "valid" and is not touched.  Note: to properly handle non 'entn''s this
  1269. routine must and will zero the high long (source) of the cid! Safe to pass
  1270. dereferenced handle(s).
  1271. }
  1272. PROCEDURE OCESetRecipientType(extensionType: OSType; VAR cid: CreationID);
  1273.     {$IFC NOT GENERATINGCFM}
  1274.     INLINE $303C, $0343, $AA5C;
  1275.     {$ENDC}
  1276. {
  1277. ***************************************************************************************
  1278.    PLEASE NOTE! ROUTINES HAVE MOVED TO THIS HEADER!
  1279.  
  1280.    OCEGetAccessControlDSSpec and its corresponding data type and constants have
  1281.    moved to the OCE header from OCEAuthDir. The OCEAuthDir header includes the OCE
  1282.    header, so no changes to your code are required.
  1283.    
  1284. ***************************************************************************************
  1285. }
  1286. {  access categories bit numbers  }
  1287.  
  1288. CONST
  1289.     kThisRecordOwnerBit            = 0;
  1290.     kFriendsBit                    = 1;
  1291.     kAuthenticatedInDNodeBit    = 2;
  1292.     kAuthenticatedInDirectoryBit = 3;
  1293.     kGuestBit                    = 4;
  1294.     kMeBit                        = 5;
  1295.  
  1296. {  Values of CategoryMask  }
  1297.     kThisRecordOwnerMask        = $00000001;
  1298.     kFriendsMask                = $00000002;
  1299.     kAuthenticatedInDNodeMask    = $00000004;
  1300.     kAuthenticatedInDirectoryMask = $00000008;
  1301.     kGuestMask                    = $00000010;
  1302.     kMeMask                        = $00000020;
  1303.  
  1304.  
  1305. TYPE
  1306.     CategoryMask                        = LONGINT;
  1307. {
  1308. pass kThisRecordOwnerMask, kFriendsMask, kAuthenticatedInDNodeMask, kAuthenticatedInDirectoryMask,
  1309. kGuestMask, or kMeMask to this routine, and it will return a pointer to a
  1310. DSSpec that can be used in the Get or Set Access Controls calls.
  1311. }
  1312. FUNCTION OCEGetAccessControlDSSpec(categoryBitMask: CategoryMask): DSSpecPtr;
  1313.     {$IFC NOT GENERATINGCFM}
  1314.     INLINE $303C, $0345, $AA5C;
  1315.     {$ENDC}
  1316. {$ENDC}
  1317. {$ALIGN RESET}
  1318. {$POP}
  1319.  
  1320. {$SETC UsingIncludes := OCEIncludes}
  1321.  
  1322. {$ENDC} {__OCE__}
  1323.  
  1324. {$IFC NOT UsingIncludes}
  1325.  END.
  1326. {$ENDC}
  1327.